Skip to content

docs: clarify user paths and badge surface#23

Merged
anand-testcompare merged 1 commit into
mainfrom
docs/readme-paths-badges
Apr 21, 2026
Merged

docs: clarify user paths and badge surface#23
anand-testcompare merged 1 commit into
mainfrom
docs/readme-paths-badges

Conversation

@anand-testcompare

@anand-testcompare anand-testcompare commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • promote the DeepWiki badge and tighten the README badge surface
  • move the main README to a top-first decision guide for one-off export, local recurring analysis, Databricks, and Palantir Foundry
  • replace bullet-style command references with fenced bash examples
  • clarify that .memory/ is only the repo default, not a required output location
  • separate end-user/operator docs from contributor-oriented CLI docs
  • add a demo storyboard doc for future screenshots and video capture

Verification

  • validated badge and doc URLs with curl -I
  • python ~/.agents/skills/readme-maintainer/scripts/readme_facts.py --repo . --format markdown
  • cargo fmt --all --check
  • cargo clippy --workspace --all-targets --all-features -- -D warnings
  • cargo test --workspace

Open in Devin Review

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@anand-testcompare anand-testcompare merged commit 879cccb into main Apr 21, 2026
10 checks passed
@anand-testcompare anand-testcompare deleted the docs/readme-paths-badges branch April 21, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant